Server API logging

Logging of API requests (Web API and OData) can be enabled. Log files are generated in the server 'Logs' folder on each IPS server machine, using the 'NCSA Combined Log Format' (i.e., web server log format).

The log files are only accessible to Windows system administrators via login to the server machine(s).

Note: In a clustered deployment with multiple server machines an API event will be logged on the machine that performs that request, hence a sequence of API requests could be logged across several machines.

Two log files are server-specific, and the rest are organized into folders specific to each tenant:

IPS165_LicenseServer_API_LOG.log
IPS165_TenantAuthentication_API_LOG.log
{TENANT}\IPS165_PlanningSpaceDataflow_{TENANT}_API_LOG.log
{TENANT}\IPS165_PlanningSpaceEconomics_{TENANT}_API_LOG.log
{TENANT}\IPS165_PlanningSpacePortfolio_{TENANT}_API_LOG.log
{TENANT}\IPS165_PlanningSpace_{TENANT}_API_LOG.log
{TENANT}\IPS165_TenantAuthentication_{TENANT}_API_LOG.log
{TENANT}\IPS165_TenantDeployment_{TENANT}_API_LOG.log
{TENANT}\IPS165_TenantHome_{TENANT}_API_LOG.log

'Capture Api Traffic' service setting

Logging is enabled using the IPS service setting Capture Api Traffic. The setting applies to all tenants in a Planning Space deployment.

Note: API log files are not deleted if the setting is changed from True to False. Logging will re-start using the same files if the setting is changed again.